home *** CD-ROM | disk | FTP | other *** search
/ Compendium Deluxe 1 / LSD Compendium Deluxe 1.iso / a / programming / assembly / ls55+44.lha / ls.doc < prev    next >
Encoding:
Text File  |  1993-07-18  |  5.0 KB  |  198 lines
  1.  
  2. (Tiny)ls 4.4 and 5.0 by Jörgen Grahn
  3. ====================================
  4.  
  5. Note #1:
  6. ========
  7.  
  8.     I've always called this program 'ls'.
  9.     As there are tons of 'ls' programs available,
  10.     I've chosen to call the distribution 'TinyLs'.
  11.  
  12. Note #2:
  13. ========
  14.  
  15.     I released an earlier version, TinyLs 4.1,
  16.     on UseNet in 1992. That version had a couple
  17.     of bugs that could cause crashes. In fact,
  18.     parts of the code was rather crappy :-).
  19.  
  20. Introduction:
  21. =============
  22.  
  23.     (Tiny)ls is a directory listing program.
  24.     It has *not* the fancy features of programs
  25.     such as NewList or different ports of and
  26.     variations of the UN*X 'ls' command. It has
  27.     only two distinct features:
  28.  
  29.     x It is small. Takes virtually no RAM or Disk
  30.       space. Good for floppy-only users.
  31.  
  32.     x Its output does not waste shell window space,
  33.       and gives a good overview by printing files
  34.       and directories in different colours.
  35.  
  36.     Both version 4.4 and 5.0 are enclosed in this
  37.     distribution. 4.4 is 496 bytes long; thus it only
  38.     occupies two (?) disk blocks on a FFS floppy.
  39.     No file on floppy can occupy less space.
  40.     5.0 occupies one more block. Yeah I know it's
  41.     cheap counting blocks, but someone may need it.
  42.     God knows I don't :-).
  43.  
  44. Requirements:
  45. =============
  46.  
  47.     Any Amiga with OS 2.0 or higher.
  48.  
  49. Format:
  50. =======
  51.  
  52.     LS [directory]
  53.  
  54.     If no directory name is given, ls will list the
  55.     contents of the current directory.
  56.     Wildcards don't work.
  57.  
  58. Template:
  59. =========
  60.  
  61.     DIR
  62.  
  63. Features:
  64. =========
  65.  
  66.     x Ls is a small program. It does not occupy
  67.       much disk space, and not much RAM when
  68.       running or resident.
  69.  
  70.     x Ls can be made resident.
  71.  
  72.     x Since file names are printed one at a time,
  73.       waiting for a listing from a slow floppy
  74.       is not as frustrating as waiting for C:Dir
  75.       to finish.
  76.  
  77.     x Ls prints names in a compact way; four filenames
  78.       on each row. It will take very large directories
  79.       to make filenames scroll away.
  80.  
  81.     x Ls 5.0 makes different kinds of files easily distinguishable
  82.       by highlighting them in different ways:
  83.  
  84.       black text:    file
  85.       black italic: hardlink to file
  86.       blue text:    directory
  87.       blue italic:    hardlink to directory
  88.       white text:    softlink to file or directory
  89.  
  90.       (Ls 4.4 only prints files in black and directories and
  91.       softlinks in blue.)
  92.  
  93.     x Ls understands CTRL-C.
  94.  
  95.     x Ls has a version string.
  96.  
  97.     x Ls gives error reports much like the C: commands.
  98.  
  99. Bugs and drawbacks:
  100. ===================
  101.  
  102.     x Ls doesn't understand wildcards, or anything else than
  103.       a single filename for that matter.
  104.  
  105.     x Ls doesn't always print a meaningful error message when
  106.       something went wrong. It usually does though.
  107.  
  108.     x Ls is a AmigaOS 2.0+ only utility. It uses
  109.       v36 dos.library command line parsing, error report...
  110.       I have a working 1.2+ version though,
  111.       but it is too messy to release ;-(
  112.  
  113.     x Ls has the same name as tons of more sophisticated
  114.       utilities ;-)
  115.  
  116.     x Don't supply an icon for ls. Ls won't run from Workbench.
  117.       Besides, doing so would be pointless, wouldn't it?
  118.  
  119.     x On a two-colour screen, softlinks that are printed in colour
  120.       #2, will not be visible. On the other hand, window titles
  121.       won't be visible either ;-).
  122.  
  123.     x Printing of file names is not the fastest possible. Normally
  124.       reading names from disk takes much more time, but listing ram
  125.       disks could be say 20% faster.
  126.  
  127. Conclusions:
  128. ============
  129.  
  130.     If you do a lot of shell work, you need to list
  131.     directories often. Maybe one out of three commands
  132.     is a listing command. If your shell does not have
  133.     file name completion, they may be more. If your window
  134.     is too small, listings often scroll away and have to be
  135.     redone. (Tiny)ls's concise and clear output helps in
  136.     this case.
  137.  
  138.     If you have a large system, you might want to use another
  139.     utility instead. Personally, I always use (tiny)ls for
  140.     normal listings and C:List for more advanced things.
  141.  
  142. History:
  143. ========
  144.     See source.
  145.  
  146. Thanks to:
  147. ==========
  148.  
  149.     x Jeff Lavin, for his detailed comments on ls 4.1, and
  150.       for pointing out the embarrasing reentrancy mistake...
  151.  
  152.     x All you freeware programmers. You built my computer.
  153.  
  154. Plugs:
  155. ======
  156.  
  157.     x GMC 9.18        An excellent console-handler
  158.                 with filename completion!
  159.  
  160.     x NetHack 3.1.1        The most addictive game *ever*!
  161.  
  162.     x UpCat            A very nice program to keep
  163.                 a database of your floppy disks.
  164.  
  165.     x SnoopDOS 1.7        Invaluable!
  166.  
  167.     x SiliconMenus        Cool popup-menus!
  168.  
  169.     x Imploder 4.0        The best and safest executable
  170.                 packer available.
  171.  
  172. Distribution & disclaimer:
  173. ==========================
  174.  
  175.     I guess I can't demand money for this ;->,
  176.     so ls is kind of freeware.  Feel free to do
  177.     what you want with this executable and to change
  178.     the source to fit your needs.  Please credit me
  179.     for what I've done, and please don't credit me for
  180.     what you've done (such as adding link viruses to ls ;-).
  181.     And don't blame me for the results of using this
  182.     distribution.
  183.  
  184. Address:
  185. ========
  186.  
  187.     Jörgen Grahn
  188.     Wetterlinsg. 13e
  189.     521 34 Falköping
  190.     SWEDEN
  191.  
  192.     Not much email access after this (1993) summer,
  193.     but if you want to, you can try any of the following,
  194.     and I may or may not get the message.
  195.  
  196.     ex-grahn@student.cs.chalmers.se
  197.     lundgren@fy.chalmers.se
  198.